Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

pkg-dir

Package Overview
Dependencies
Maintainers
1
Versions
11
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

pkg-dir

Find the root directory of a Node.js project or npm package

  • 2.0.0
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created

What is pkg-dir?

The pkg-dir npm package is designed to help developers find the root directory of a Node.js project or npm package. This is particularly useful in situations where your code needs to access project-wide resources or configurations, and you need a reliable way to locate the root directory of the project, regardless of the current working directory of the process.

What are pkg-dir's main functionalities?

Find the root directory of a project

This feature allows you to asynchronously find the root directory of a project by passing the current directory to the function. It returns a promise that resolves with the path to the nearest package directory.

const pkgDir = require('pkg-dir');

(async () => {
  const rootDir = await pkgDir(__dirname);
  console.log(rootDir);
})();

Synchronous finding of the project root directory

For scenarios where asynchronous code is not ideal, pkg-dir provides a synchronous method to find the project root directory. This method is useful in synchronous scripts or module initialization.

const pkgDir = require('pkg-dir');

const rootDir = pkgDir.sync(__dirname);
console.log(rootDir);

Other packages similar to pkg-dir

Keywords

FAQs

Package last updated on 04 May 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc